iDRAC 8/7 v2.40.40.40 RACADM CLI Guide

Modifies the value of configuration objects on a component. The Set sub-command has two forms:

• The modification of a single object to a new value specified in the command line.
• The modification of multiple objects to new values using a configuration file.

  It supports multi-object value import from two configuration file formats.

  • INI format — The INI format files can be imported from a local file only
  • Server Configuration Profile XML format — XML format files can be imported from a local file, from an NFS network share or from a CIFS network share.
    • NOTE: To run the Set sub-command for Server Configuration Profile XML files, use the Lifecycle Controller version 1.1 or later.

  Depending on the type of configuration object being modified, the new values could be applied immediately (in “real-time”) or require staging and a reboot of the system to apply the new values. The following components support either real-time or staged application of new values:

  • iDRAC with Lifecycle Controller
  • PERC RAID controllers
    • NOTE: Use PERC RAID controllers with firmware version 9.1 or later. The real-time support is provided only while performing hardware RAID configuration.

The following components require staging and system reboot for application of new values:

• BIOS
• Other PERC RAID controllers — For software RAID configuration
• Networking devices – Ethernet and Fibre Channel

Single-object Set

• racadm set <FQDD Alias>.<group> <value>

• racadm get <FQDD Alias>.<group>.<object> <value>

• racadm get <FQDD Alias>.<group>.[<index>].<object> <value>

• racadm get <FQDD Alias>.<index>.<group>.<index>.<object> <value>

Multi-object Set

• racadm set -f <filename> [-t ini] [--continue]

• racadm set -f <filename> -t xml -l <NFS share> [--preview] [--continue]

• racadm set -f <filename> -t xml -l <NFS share> -c <FQDD>[,<FQDD>*]

• racadm set -f <filename> -t xml -u <username> -p <password> -l <CIFS share> [--preview] [--continue] 

• racadm set -f <filename> -t xml -u <username> -p <password> -l <CIFS share> -c <FQDD>[,<FQDD>*]

• <FQDD Alias>

  Examples for FQDDs:

  • System.Power
  • System.Power.Supply
  • System.Location
  • LifecycleController.LCAttributes
  • System.LCD
  • iDRAC.Serial
• <group> — Specifies the group containing the object that must be written.
• <object> — Specifies the object name of the value that must be written.
• <index> — This option is specified where FQDD Aliases or Groups must be indexed.
• -f <filename> — Enables set to configure the device from a specified file. This option is not supported in the Firmware RACADM interface.
• --continue — This option is used with –f only and is applicable for only for INI file operation.. If a multi-object Set is unsuccessful for a <group>, then Set continues with the next <group> in the file. If this option is not used, then Set stops when it is unsuccessful for a particular <group>. After the unsuccessful <group>, the remaining <group>s are not configured.
  • NOTE:
  This option is applicable only for INI file operation.
• -u — Specifies user name of the CIFS remote share from which the file must be imported
• -p — Specifies password for the remote CIFS share from which the file must be imported.
• -l — Specifies network share location from where the file must be imported.
• -t — Specifies the file type to be imported. Valid values are xml and INI. INI files can only be imported from a local file. XMLimports the Server Configuration Profile in XMLformat either from a local or network share file.
  • NOTE: To import or export Server Configuration Profile .xml, use the Lifecycle Controller version 1.1 or later.

Staging and reboot control options

The following options control when and how system reboots are performed when using the –f option. As noted above, some FQDDs require a system reboot to apply the new values; other FQDDs optionally support immediate application of new values. If the imported file contains ONLY immediate application-capable FQDDs such as iDRAC, do NOT use the –b option and the Set command will schedule a real-time job to immediately apply the new values.

• -b — . Specifies the type of shutdown for the system after a file import operation completes. The parameters are Graceful, Forced, and NoReboot for graceful shutdown, forced shutdown, and no reboot respectively. If -b is not specified, graceful shutdown is taken as the default except as noted above for files containing new values for immediate application-capable <FQDD>s.
  • NOTE: If the operating system is in use, then the graceful shutdown option may time out within 300 seconds. If this operation is unsuccessful, then retry with the force option.
• -w — Maximum time to wait for the graceful shutdown to occur. The value must be entered in seconds. Minimum accepted value is 300 seconds and the maximum accepted value is 3600 seconds. The default value is 1800 seconds.
• -s — Power state of the host when the import operation completes. The parameters are "On" for powered ON and "Off" for powered OFF. If this parameter is not specified, power ON is taken as default.
• --preview — Validates the configuration .xml file and view the status.

  The --preview option provides the Job ID to verify the status of the file preview operation. The Job ID can be tracked by running the racadm jobqueue view –I <JID> command.

  • NOTE:
    • The --preview option does not restart the system.
    • The -b, -w options cannot be included with the --preview option.
    • A scheduled job or pending configuration should not be running while using the --preview option.
• -c — Specifies the FQDD or list of FQDDs separated by ',' of the components for which the configurations should be imported. If this option is not specified, configuration related to all the components are imported.

Single-object Set of real-time objects

• Configure LCD String.

  $ racadm set system.lcd.LCDUserString test 

• • Configure iDRAC name.
  racadm set iDRAC.Info.Name idrac-server100

Single-object Set of staged objects

• Configure several BIOS settings, create a job to initiate application of new values, reboot the system, then wait for the job to complete.

  racadm set BIOS.SysProfileSettings.ProcTurboMode Disabled racadm set BIOS.ProcSettings.ProcVirtualization Enabled racadm set BIOS.ProcSettings.ControlledTurbo Enabled racadm jobqueue create BIOS.Setup.1-1 –r Graceful

  • Make note of the Job ID output by the jobqueue command
  • After reboot, wait for the job to complete by checking the job status

    racadm jobqueue view –i <Job ID>

Multi-object Set of real-time objects

• Configure the iDRAC using a local INI file.

  racadm set -f myidrac.ini

• Configure the iDRAC using a local Server Configuration Profile XML file containing only iDRAC settings.

  racadm set -f myidrac.xml -t xml

• Configure the iDRAC using a Server Configuration Profile XML file stored on an NFS share containing only iDRAC settings.

  racadm set -f myidrac.xml -t xml -l 10.1.2.3:/myshare

• Import a Server Configuration Profile from a CIFS share, using only the iDRAC component.

  racadm set -f file –t xml -u myuser -p mypassword -l //192.168.0/share -c iDRAC.Embedded.1

Multi-object Set of staged objects

• Configure a systems using a local Server Configuration Profile XML file containing a mix of real-time and staged objects; reboot the server gracefully with a wait time of ten minutes, leaving the server powered on after the reboot.

  racadm set -f myfile.xml -t xml -b "graceful" -w 600 -s "on"

  • Make note of the Job ID output by the Set command.
  • After reboot, wait for the job to complete by checking the job status.

    racadm jobqueue view –i <Job ID>

• Configure a systems using a local Server Configuration Profile XML file containing a mix of real-time and staged objects; postpone reboot until other operations have been completed.

  racadm set -f myfile.xml -t xml -b NoReboot

  • Make note of the Job ID output by the Set command; because of the NoReboot option, the job will be pending until the server is rebooted
  • Complete other operations, then perform a reboot
  • After reboot, wait for the job to complete by checking the job status

    racadm jobqueue view –i <Job ID>

• Verify the Server Configuration Profile XML file content located in a remote CIFS share.

  racadm set -f temp_Configuration_file -t xml -u Administrator -p Password -l //192.168.0/xyz –preview